类 FoxitPDFSDKPython3.PDFObject 继承关系图:

Public 成员函数
def	CloneObject ()
	克隆当前PDF对象并获取克隆的PDF对象。更多...

def	DeepCloneObject ()
	克隆当前PDF对象并获取克隆的PDF对象。更多...

def	GetArray ()
	获取当前PDF对象的PDF数组对象。更多...

def	GetBoolean ()
	获取当前PDF对象的布尔值。更多...

def	GetDateTime ()
	获取当前PDF对象的日期时间值。更多...

def	GetDict ()
	获取当前PDF对象的PDF字典对象。更多...

def	GetDirectObject ()
	获取当前PDF对象的直接对象。更多...

def	GetFloat ()
	获取当前PDF对象的浮点数值。更多...

def	GetInteger ()
	获取当前PDF对象的整数值。更多...

def	GetMatrix ()
	获取当前PDF对象的矩阵值。更多...

def	GetName ()
	获取当前PDF对象的名称值。更多...

def	GetObjNum ()
	获取当前PDF对象的间接对象编号。更多...

def	GetRect ()
	获取当前PDF对象的矩形值。更多...

def	GetStream ()
	获取当前PDF对象的PDF流对象。更多...

def	GetString ()
	获取当前PDF对象的字符串值。更多...

def	GetType ()
	获取当前PDF对象的类型。更多...

def	GetWideString ()
	获取当前PDF对象的宽字符串值。更多...

def	IsIdentical (pdf_obj)
	检查输入的PDF对象是否与当前PDF对象相同。更多...

def	Release ()
	释放新创建的PDF对象或克隆PDF对象，该对象与PDF文档或其他PDF对象无关且不会再使用。更多...

静态 Public 成员函数
def	CreateFromBoolean (boolean_value)
	从布尔值创建PDF对象。更多...

def	CreateFromDateTime (date_time)
	从日期时间创建PDF对象。更多...

def	CreateFromFloat (float_value)
	从浮点数创建PDF对象。更多...

def	CreateFromInteger (integer_value)
	Create a PDF object from a integer number. 更多...

def	CreateFromName (name)
	从表示名称的字符串创建PDF对象。更多...

def	CreateFromNameW (name)
	从表示名称的字符串创建PDF对象。更多...

def	CreateFromString (string_value)
	从字符串创建PDF对象。更多...

def	CreateFromString (string_value, length)
	从字符串创建PDF对象。更多...

def	CreateReference (document, object_number)
	为间接对象创建引用。更多...

静态 Public 属性
	e_Array = _fsdk.PDFObject_e_Array
	PDF数组对象。

	e_Boolean = _fsdk.PDFObject_e_Boolean
	PDF布尔对象。

	e_Dictionary = _fsdk.PDFObject_e_Dictionary
	PDF字典对象。

	e_InvalidType = _fsdk.PDFObject_e_InvalidType
	无效的PDF对象类型。

	e_Name = _fsdk.PDFObject_e_Name
	PDF名称对象。

	e_Null = _fsdk.PDFObject_e_Null
	PDF空对象。

	e_Number = _fsdk.PDFObject_e_Number
	PDF数字对象。

	e_Reference = _fsdk.PDFObject_e_Reference
	PDF引用对象。

	e_Stream = _fsdk.PDFObject_e_Stream
	PDF流对象。

	e_String = _fsdk.PDFObject_e_String
	PDF字符串对象。

详细描述

PDF支持八种基本类型的对象：
“布尔值”、“整数和实数”、“字符串”、“名称”、 “数组”、“字典”、“流”、“空对象”。有关PDF对象的更多详细信息，请参考<PDF Reference 1.7>中的第3.2节“对象”。
类PDFObject 是所有类型PDF对象的基类。它提供了不同的函数来创建不同类型的PDF对象。对于“数组”、“字典”和“流”PDF对象，请参考派生类FoxitPDFSDKPython3.PDFArray 、FoxitPDFSDKPython3.PDFDictionary 和PDFStream 。
如果用户想要将新创建的PDF对象设为间接对象，请调用函数 FoxitPDFSDKPython3.PDFDoc.AddIndirectObject 。

参见: PDFArray; PDFDictionary; PDFStream; FoxitPDFSDKPython3.PDFDoc

成员函数说明

◆ CloneObject()

def FoxitPDFSDKPython3.PDFObject.CloneObject ( )

克隆当前PDF对象并获取克隆的PDF对象。

如果新对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

返回: 一个新的PDFObject 对象作为克隆结果。如果有任何错误，此函数将返回null。

◆ CreateFromBoolean()

FoxitPDFSDKPython3.PDFObject.CreateFromBoolean ( boolean_value )

static

从布尔值创建PDF对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数

[in] boolean_value 一个布尔值。

返回: 一个新的PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_Boolean 。如果有任何错误，此函数将返回null。

◆ CreateFromDateTime()

FoxitPDFSDKPython3.PDFObject.CreateFromDateTime ( date_time )

static

从日期时间创建PDF对象。

PDF定义了一种标准的日期格式，它严格遵循国际标准ASN.1（抽象语法记号法一），定义于ISO/ IEC 8824（请参阅参考文献）。日期被定义为以下形式的ASCII字符串 (D:YYYYMMDDHHmmSSOHH'mm')。如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数

[in] date_time 一个日期和时间对象。

返回: 一个新的PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_String 。如果有任何错误，此函数将返回null。

◆ CreateFromFloat()

FoxitPDFSDKPython3.PDFObject.CreateFromFloat ( float_value )

static

从浮点数创建PDF对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数

[in] float_value 一个浮点值。

返回: 一个新的PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_Number 。如果有任何错误，此函数将返回null。

◆ CreateFromInteger()

FoxitPDFSDKPython3.PDFObject.CreateFromInteger ( integer_value )

static

Create a PDF object from a integer number.

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数

[in] integer_value 一个整数值。

返回: 一个新的PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_Number 。如果有任何错误，此函数将返回null。

◆ CreateFromName()

FoxitPDFSDKPython3.PDFObject.CreateFromName ( name )

static

从表示名称的字符串创建PDF对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数

[in] name 一个字符串。不应为空字符串。

返回: 一个新的PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_Name 。如果有任何错误，此函数将返回null。

◆ CreateFromNameW()

FoxitPDFSDKPython3.PDFObject.CreateFromNameW ( name )

static

从表示名称的字符串创建PDF对象。

参数

[in] name 一个字符串。不应为空字符串。

返回: 一个新的PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_Name 。如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

◆ CreateFromString() [1/2]

FoxitPDFSDKPython3.PDFObject.CreateFromString ( string_value )

static

从字符串创建PDF对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数

[in] string_value 一个字符串。不应为空字符串。

返回: 一个PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_String 。如果有任何错误，此函数将返回null。

◆ CreateFromString() [2/2]

FoxitPDFSDKPython3.PDFObject.CreateFromString	(	string_value,
		length
	)

static

从字符串创建PDF对象。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数

[in]	string_value	一个字符串。不应为空字符串。
[in]	length	宽字符串的长度。长度应该是正值或-1。值-1表示以零结尾的宽字符串。

返回: 一个PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_String 。如果有任何错误，此函数将返回null。

◆ CreateReference()

FoxitPDFSDKPython3.PDFObject.CreateReference	(	document,
		object_number
	)

static

为间接对象创建引用。

可以通过以下方法获取间接对象：

由函数FoxitPDFSDKPython3.PDFDoc.GetIndirectObject 返回。
由函数FoxitPDFSDKPython3.PDFDoc.AddIndirectObject 返回，当尝试将直接PDF对象添加到PDF文档并使其成为间接对象时。

如果创建的对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用函数FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

参数

[in]	document	一个有效的PDF文档对象。
[in]	object_number	间接PDF对象的间接对象编号。该值应大于0。

返回: 一个新的PDFObject 对象，其对象类型为FoxitPDFSDKPython3.PDFObject.e_Reference 。如果有任何错误，此函数将返回null。

◆ DeepCloneObject()

def FoxitPDFSDKPython3.PDFObject.DeepCloneObject ( )

克隆当前PDF对象并获取克隆的PDF对象。

此函数是完全的直接复制，内部没有任何引用对象，因此复制的对象可以被复制到另一个文档。如枟新对象尚未添加/设置到PDF文档或其他PDF对象中且不会再使用，请调用FoxitPDFSDKPython3.PDFObject.Release 来释放该对象。

返回: 一个新的PDFObject 对象作为克隆结果。如果有任何错误，此函数将返回null。

◆ GetArray()

def FoxitPDFSDKPython3.PDFObject.GetArray ( )

获取当前PDF对象的PDF数组对象。

如果当前PDF对象的类型是FoxitPDFSDKPython3.PDFObject.e_Reference ，此函数将检查当前PDF对象的直接PDF对象。

返回: 一个PDF数组对象。如果当前PDF对象或直接PDF对象不是PDF数组，将返回null。

◆ GetBoolean()

def FoxitPDFSDKPython3.PDFObject.GetBoolean ( )

获取当前PDF对象的布尔值。

仅当当前PDF对象的类型为FoxitPDFSDKPython3.PDFObject.e_Boolean 时有用。

返回: 布尔值。对于其他类型的PDF对象，将返回false。

◆ GetDateTime()

def FoxitPDFSDKPython3.PDFObject.GetDateTime ( )

获取当前PDF对象的日期时间值。

仅当当前PDF对象的类型为FoxitPDFSDKPython3.PDFObject.e_String 且其内容为PDF标准日期格式时有用。

返回: 日期时间信息。如果有任何错误或当前对象为其他类型，将返回一个空的日期和时间对象。

◆ GetDict()

def FoxitPDFSDKPython3.PDFObject.GetDict ( )

获取当前PDF对象的PDF字典对象。

如果当前PDF对象的类型是FoxitPDFSDKPython3.PDFObject.e_Reference ，此函数将检查当前PDF对象的直接PDF对象。

返回: 一个PDF字典对象。如果当前PDF对象或直接PDF对象不是PDF字典，将返回null。

◆ GetDirectObject()

def FoxitPDFSDKPython3.PDFObject.GetDirectObject ( )

获取当前PDF对象的直接对象。

如果当前PDF对象的类型是FoxitPDFSDKPython3.PDFObject.e_Reference ，将返回直接对象。

返回: 直接PDF对象。对于其他类型的PDF对象，此函数将返回当前PDF对象本身。如果有任何错误，此函数将返回null。

◆ GetFloat()

def FoxitPDFSDKPython3.PDFObject.GetFloat ( )

获取当前PDF对象的浮点数值。

仅当当前PDF对象的类型为FoxitPDFSDKPython3.PDFObject.e_Number 时有用。

返回: 浮点数值。对于其他类型的PDF对象，将返回0.0f。

◆ GetInteger()

def FoxitPDFSDKPython3.PDFObject.GetInteger ( )

获取当前PDF对象的整数值。

仅当当前PDF对象的类型为FoxitPDFSDKPython3.PDFObject.e_Number 时有用。

返回: 整数值。对于其他类型的PDF对象，将返回0。

◆ GetMatrix()

def FoxitPDFSDKPython3.PDFObject.GetMatrix ( )

获取当前PDF对象的矩阵值。

仅对类型为FoxitPDFSDKPython3.PDFObject.e_Array 且包含6个数字对象作为元素的PDF对象有用。

返回: 一个矩阵。如果有任何错误或当前对象为其他类型，将返回值为[0 0 0 0 0 0]的矩阵。

◆ GetName()

def FoxitPDFSDKPython3.PDFObject.GetName ( )

获取当前PDF对象的名称值。

仅当当前PDF对象的类型为 FoxitPDFSDKPython3.PDFObject.e_Name 或FoxitPDFSDKPython3.PDFObject.e_String 时有用。

返回: 表示该值的字符串。如果有任何错误或当前对象为其他类型，将返回空字符串。

◆ GetObjNum()

def FoxitPDFSDKPython3.PDFObject.GetObjNum ( )

获取当前PDF对象的间接对象编号。

返回

间接对象编号。它可能是：

0，如果当前PDF对象是直接对象。
大于0，如果当前PDF对象是间接对象。
-1表示有任何错误。

◆ GetRect()

def FoxitPDFSDKPython3.PDFObject.GetRect ( )

获取当前PDF对象的矩形值。

仅对类型为FoxitPDFSDKPython3.PDFObject.e_Array 且包含4个数字对象作为元素的PDF对象有用。

返回: 一个矩形。如果有任何错误或当前对象为其他类型，将返回值为[0 0 0 0]的矩形。

◆ GetStream()

def FoxitPDFSDKPython3.PDFObject.GetStream ( )

获取当前PDF对象的PDF流对象。

如果当前PDF对象的类型是FoxitPDFSDKPython3.PDFObject.e_Reference ，此函数将检查当前PDF对象的直接PDF对象。

返回: 一个PDF流对象。如果当前PDF对象或直接PDF对象不是PDF流，将返回null。

◆ GetString()

def FoxitPDFSDKPython3.PDFObject.GetString ( )

获取当前PDF对象的字符串值。

此函数将获取当前PDF对象实际值的字符串格式：

如果对象类型为FoxitPDFSDKPython3.PDFObject.e_Boolean ，将返回"true"或"false"字符串值，具体取决于其实际值。
如枟对象类型为FoxitPDFSDKPython3.PDFObject.e_Number ，该值将被表示为字符串。例如，值1.5将表示为"1.5"字符串。
如果对象类型为FoxitPDFSDKPython3.PDFObject.e_String ，将直接检索字符串值。

如果当前PDF对象的值无法转换为有效的字符串，将返回空字符串。

返回: 一个字符串。

◆ GetType()

def FoxitPDFSDKPython3.PDFObject.GetType ( )

获取当前PDF对象的类型。

返回: PDF对象类型。请参考从FoxitPDFSDKPython3.PDFObject.e_Boolean 开始的值，此值将是这些值之一。

◆ GetWideString()

def FoxitPDFSDKPython3.PDFObject.GetWideString ( )

获取当前PDF对象的宽字符串值。

此函数将获取当前PDF对象实际值的字符串格式：

如果对象类型为FoxitPDFSDKPython3.PDFObject.e_Boolean ，将返回"true"或"false"字符串值，具体取决于其实际值。
如果对象类型为FoxitPDFSDKPython3.PDFObject.e_Number ，该值将被表示为字符串。例如，值1.5将表示为"1.5"字符串。
如果对象类型为FoxitPDFSDKPython3.PDFObject.e_String ，将直接检索字符串值。

如果当前PDF对象的值无法转换为有效的字符串，将返回空字符串。

返回: 一个字符串。

◆ IsIdentical()

def FoxitPDFSDKPython3.PDFObject.IsIdentical ( pdf_obj )

检查输入的PDF对象是否与当前PDF对象相同。

参数

[in] pdf_obj 另一个PDF对象，将与当前PDF对象进行比较。

返回: true表示输入的PDF对象与当前PDF对象相同，而false表示输入的PDF对象与当前PDF对象不相同。

◆ Release()

def FoxitPDFSDKPython3.PDFObject.Release ( )

释放新创建的PDF对象或克隆PDF对象，该对象与PDF文档或其他PDF对象无关且不会再使用。

此函数应仅用于新创建的PDF对象或克隆的PDF对象，该对象尚未被添加或设置到其他PDF对象或与PDF文档相关联，且不会再使用。请勿在其他情况下使用此函数，否则可能会发生未知错误。

返回: 无。

Public 成员函数

静态 Public 成员函数

静态 Public 属性

详细描述

成员函数说明

◆ CloneObject()

◆ CreateFromBoolean()

◆ CreateFromDateTime()

◆ CreateFromFloat()

◆ CreateFromInteger()

◆ CreateFromName()

◆ CreateFromNameW()

◆ CreateFromString() [1/2]

◆ CreateFromString() [2/2]

◆ CreateReference()

◆ DeepCloneObject()

◆ GetArray()

◆ GetBoolean()

◆ GetDateTime()

◆ GetDict()

◆ GetDirectObject()

◆ GetFloat()

◆ GetInteger()

◆ GetMatrix()

◆ GetName()

◆ GetObjNum()

◆ GetRect()

◆ GetStream()

◆ GetString()

◆ GetType()

◆ GetWideString()

◆ IsIdentical()

◆ Release()